Reformat gradle files with IntelliJ / .editorconfig #4037

dsmiley · 2026-01-07T04:43:10Z

I told IntelliJ to reformat all gradle files. It uses the rules in our .editorconfig.
Also did a little hand-editing.

Once this is merged, I will record the commit in .git-blame-ignore-revs with a changelog entry with the title: Reformat gradle files with IntelliJ / .editorconfig

dsmiley · 2026-01-07T04:45:42Z

Unlike #4009 , there is no cost/time overhead (very high for "greclipse" !) or build complexity (however small) to maintain. True that there will be some inconsistency but we have a .editorconfig which should reduce that, especially amongst IntelliJ users. This is an improvement!

dsmiley · 2026-01-09T03:56:06Z

gradle/documentation/pull-lucene-javadocs.gradle

      def resolved = configurations.javadocs.resolvedConfiguration
-      resolved.resolvedArtifacts.each { artifact ->
+      resolved.resolvedArtifacts.each {artifact
+        ->


don't love this newline left of the arrow; rather inconsistent. I fiddled with it now and it's appears to be because there are lines below that exceed 100 chars. Tweaks to them result in keeping the newline as it's been, which is nicer. I'll push a fix.

by reflowing to the 100 char width budget. Also removed a couple cases where we didn't need to pass an arg to the lambda.

dsmiley · 2026-01-09T20:43:05Z

I plan to merge this Monday night, subject to further review.

dweiss · 2026-01-11T08:36:49Z

I agree, greclipse is a monster. I remember thinking this kind of costly linter/ formatter stuff could be done on nightly workflows automatically - if the code compiles.

malliaridis

Coming from the official Kotlin code conventions there are a few rules I'd like to adjust, but I am not sure which editorconfig rule(s) are required for these.

Parameters of functions that exceed the max line length should be chopped down. They are currently wrapped at the point where max line length is exceeded
Add space after the opening and before the closing braces, and write closing braces in new line (ij_groovy_spaces_within_braces = true and probably another rule)
Chop down arrays, lists etc. rather than wrapping, see example. It seems that the intellij formatter does not have any working rule for groovy
Chop down chained method calls when too long (this one also has multiple rules work together probably, but still not nice format)
Closing parentheses in multi-line function calls should be written in new lines (see point 1 example)

For 1. we often have this:

// Current formatting
ant.concat(destfile: "${outputDir}/stylesheet.css",
  append: "true",
  fixlastline: "true",
  encoding: "UTF-8") { /*...*/ }

// Could be written as
ant.concat(
  destfile: "${outputDir}/stylesheet.css",
  append: "true",
  fixlastline: "true",
  encoding: "UTF-8",
) { /*...*/ }

For 2. it is a bit more readable when there is a space here:

.configureEach {Task task -> task.doSomething()}
// could be
.configureEach { Task task -> task.doSomething() }

For 3. we could do this:

// current
vectorIncubatorJavaVersions =
  [JavaVersion.VERSION_21, JavaVersion.VERSION_22, JavaVersion.VERSION_23, JavaVersion
    .VERSION_24, JavaVersion.VERSION_25] as Set

// Improved form
vectorIncubatorJavaVersions = [
  JavaVersion.VERSION_21,
  JavaVersion.VERSION_22,
  JavaVersion.VERSION_23,
  JavaVersion.VERSION_24,
  JavaVersion.VERSION_25,
] as Set

For 4:

// Current formatting when too long
sources +=
  sourceSet
    .java.srcDirs.findAll {dir -> dir.exists()}.collect {dir -> relativize(dir)}
sources +=
  sourceSet
    .resources
    .srcDirs.findAll {dir -> dir.exists()}.collect {dir -> relativize(dir)}

// Could be instead
sources += sourceSet.java.srcDirs
  .findAll { dir -> dir.exists() }
  .collect { dir -> relativize(dir) }
sources += sourceSet.resources.srcDirs
  .findAll { dir -> dir.exists() }
  .collect { dir -> relativize(dir) }

This formatting rules are of course just a preference that I believe provide better readability. I could point out each place individually, but ideally I'd like to have the formatter / linter take care of that instead. I have also tried to see if I can find anything else, but for groovy it seems there is none.

Perhaps that is one more reason to start migrating from Groovy to Kotlin DSL, where we can use spotless again with ktlint and official standards (or more fine-grained custom rules). 🤞

malliaridis · 2026-01-09T10:58:56Z

gradle/documentation/render-javadoc.gradle

+    opts <<
+        ['-bottom', "<i>Copyright &copy; 2000-${project.buildYear} Apache Software Foundation. All Rights Reserved.</i>"]
+
+    opts <<
+        ['-tag', 'lucene.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.']
+    opts <<
+        ['-tag', 'lucene.internal:a:NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.']
+    opts <<
+        ['-tag', "lucene.spi:t:SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service)."]


I personally like it if the opening parentheses / brackets are on the same line and the content then goes to the next line, with the closing parentehses at the last new line. Like

opts << [ '-tag', 'lucene.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.' ] opts << ['-tag', 'lucene.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.']

But it is a personal preference and takes more lines of code.

I'm now making newlines manually and IntelliJ isn't correcting me :-)

malliaridis · 2026-01-09T11:14:41Z

gradle/hacks/global-exclude-dependencies.gradle

+    exclude group: 'com.google.code.findbugs', module: 'annotations'
+    // Use Spotbugs Annotations as replacement
+    exclude group: 'javax.annotation', module: 'javax.annotation-api'
+    // Replaced with jakarta.annotation-api
    exclude group: 'org.slf4j', module: 'slf4j-log4j12' // don't include log4j 1.x
    exclude group: 'org.apache.yetus', module: 'audience-annotations' // Don't need annotations
-    exclude group: 'org.codehaus.mojo', module: 'animal-sniffer-annotations' // Don't need annotations
+    exclude group: 'org.codehaus.mojo', module: 'animal-sniffer-annotations'
+    // Don't need annotations


Auto-formatting puts trailing comments below, but I think it is better if they are above.

thanks; this very much needed correcting

dsmiley · 2026-01-11T17:47:19Z

For the most part, I've found IntelliJ to retain the newlines chosen. So we can format that way if you wish (manually). It's not clear the editorconfig/intelliJ settings are smart to what you suggest automatically.

Except...

ij_groovy_spaces_within_braces = true

But I disagree with this suggestion. When I produced this editorconfig, I intentionally aligned groovy settings with that of Java, as groovy is basically a Java derivative. Consistency across our formats is more important IMO.

malliaridis · 2026-01-13T08:57:27Z

It's not clear the editorconfig/intelliJ settings are smart to what you suggest automatically.

They aren't. I spend some time to see if I could adjust a few rules so that they do what I expect, but without success.

Consistency across our formats is more important IMO.

Definitely, please go with consistency. I just dont remember the code formatting we use in the project and I completely went with the formatting that I use in Kotlin.

Maybe formatting and linting is another reason why we should consider migrating from Groovy to Kotlin DSL? As far as I remember it would come with spotless support and good standards in formatting, plus some additional benefits like code completion and compile-time errors.

Not sure where my original message ended up or if it was never published, so I tried to rewrite what I initially had

# Conflicts: # solr/solr-ref-guide/build.gradle # solr/solrj-zookeeper/build.gradle

Includes some hand-edits. Not using Spotless because "greclipse" is very costly, and had some inconsistent inexplicable results that looked unpleasant. Follow-up commit will add changelog and `.git-blame-ignore-revs` addition

dsmiley added 2 commits January 6, 2026 23:35

Use { not ( when passing lambdas

cdd5203

intellij Reformat Code

1e23655

dsmiley requested a review from malliaridis January 7, 2026 04:43

dsmiley added the no-changelog label Jan 7, 2026

github-actions bot added documentation Improvements or additions to documentation docker Docker image test-framework client:solrj module:extraction module:s3-repository tool:build examples module:gcs-repository module:sql admin-ui cat:api labels Jan 7, 2026

dsmiley commented Jan 9, 2026

View reviewed changes

Address all casses of a line starting with an arrow

ff46cd9

by reflowing to the 100 char width budget. Also removed a couple cases where we didn't need to pass an arg to the lambda.

malliaridis reviewed Jan 11, 2026

View reviewed changes

dsmiley added 2 commits January 11, 2026 12:22

Fixes from feedback

587a776

one-off edits per Christos

262f6b0

Merge branch 'main' into reformatGradleFilesIntelliJ

cb4c7da

# Conflicts: # solr/solr-ref-guide/build.gradle # solr/solrj-zookeeper/build.gradle

dsmiley merged commit 92792f7 into apache:main Jan 14, 2026
3 of 9 checks passed

dsmiley deleted the reformatGradleFilesIntelliJ branch January 14, 2026 06:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reformat gradle files with IntelliJ / .editorconfig #4037

Reformat gradle files with IntelliJ / .editorconfig #4037

dsmiley commented Jan 7, 2026

Uh oh!

dsmiley commented Jan 7, 2026 •

edited by dweiss

Loading

Uh oh!

dsmiley Jan 9, 2026

Uh oh!

dsmiley commented Jan 9, 2026

Uh oh!

dweiss commented Jan 11, 2026

Uh oh!

malliaridis left a comment •

edited

Loading

Uh oh!

malliaridis Jan 9, 2026

Uh oh!

dsmiley Jan 11, 2026

Uh oh!

malliaridis Jan 9, 2026

Uh oh!

dsmiley Jan 11, 2026

Uh oh!

dsmiley commented Jan 11, 2026

Uh oh!

malliaridis commented Jan 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Reformat gradle files with IntelliJ / .editorconfig #4037

Reformat gradle files with IntelliJ / .editorconfig #4037

Conversation

dsmiley commented Jan 7, 2026

Uh oh!

dsmiley commented Jan 7, 2026 • edited by dweiss Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dsmiley Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

dsmiley commented Jan 9, 2026

Uh oh!

dweiss commented Jan 11, 2026

Uh oh!

malliaridis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malliaridis Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

dsmiley Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

malliaridis Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

dsmiley Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

dsmiley commented Jan 11, 2026

Uh oh!

malliaridis commented Jan 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dsmiley commented Jan 7, 2026 •

edited by dweiss

Loading

malliaridis left a comment •

edited

Loading